refactor: reorganize GitHub workflows with consistent naming convention #5891

snomiao · 2025-10-02T07:55:42Z

Summary

This PR implements a systematic naming convention for all GitHub workflows to improve organization and discoverability. All 22 workflows have been renamed and grouped by logical categories with consistent prefixes.

Changes

Naming Convention

ci-*: Continuous Integration workflows (testing, linting, validation)
pr-*: PR-specific automation triggered by labels
release-*: Release management workflows
types-*: TypeScript type generation workflows
i18n-*: Internationalization workflows

Key Renames

tests-ci.yaml → ci-tests-e2e.yaml
vitest-tests.yaml → ci-tests-unit.yaml
storybook-and-chromatic-ci.yaml → ci-tests-storybook.yaml
auto-backport.yaml → pr-backport.yaml
claude-pr-review.yml → pr-claude-review.yaml
version-bump.yaml → release-version-bump.yaml
publish-frontend-types.yaml → release-npm-types.yaml
create-dev-pypi-package.yaml → release-pypi-dev.yaml

Test Workflow Improvements

Grouped all test workflows under ci-tests-* pattern
Fork-safe deployment workflows: ci-tests-e2e-forks.yaml, ci-tests-storybook-forks.yaml
Added comments explaining fork deployment security workarounds

Documentation

Added comprehensive .github/workflows/README.md
Documents naming conventions, best practices, and workflow organization
Includes trigger patterns and external dependencies

Benefits

Better Organization: Workflows are now grouped logically by prefix
Improved Discoverability: Easy to find related workflows
Consistent Naming: All workflows follow the same pattern
Clear Purpose: Workflow names immediately indicate their function
Maintainable: README provides guidelines for future workflows

Test Plan

All workflow cross-references updated
Display names match new file names
Fork deployment workflows properly reference main workflows
Release workflows reference correct npm types workflow
All workflows retain original functionality

🤖 Generated with Claude Code

┆Issue is synchronized with this Notion page by Unito

christian-byrne · 2025-10-02T20:08:29Z

This might break a lot of other things like branch protection rules

DrJKL · 2025-10-03T03:19:17Z

This might break a lot of other things like branch protection rules

These probably aren't the names I would have gone with, but this was my idea to make the actions a little more organized and make it easier to find related workflows.

The branch protection rules would almost definitely need to be updated, GitHub isn't great about noticing changes like that.

christian-byrne · 2025-10-03T04:22:18Z

Should be fine as long as we update BP when merging. I think there's some other things like documentation, claude commands, and the PyPi and NPM auth stuff.

- Implement systematic naming convention using category prefixes - Group workflows logically: ci-, pr-, release-, types-, i18n- - Rename all 22 workflows for better organization and discoverability - Update workflow cross-references and display names - Add comprehensive README.md with naming guidelines and best practices Key changes: - CI workflows: ci-tests-e2e, ci-tests-unit, ci-tests-storybook, etc. - PR automation: pr-backport, pr-claude-review, pr-playwright-snapshots - Release management: release-version-bump, release-npm-types, etc. - Type generation: types-registry-api, types-manager-api, etc. - Internationalization: i18n-update-core, i18n-update-nodes, etc. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>

github-actions · 2025-10-08T08:26:33Z

🎨 Storybook Build Status

✅ Build completed successfully!

⏰ Completed at: 10/14/2025, 05:00:41 AM UTC

🔗 Links

📊 View Workflow Run
🎨 View Storybook

🎉 Your Storybook is ready for review!

github-actions · 2025-10-08T08:26:46Z

🎭 Playwright Test Results

⚠️ Tests passed with flaky tests

⏰ Completed at: 10/14/2025, 05:14:53 AM UTC

📈 Summary

Total Tests: 499
Passed: 467 ✅
Failed: 0
Flaky: 2 ⚠️
Skipped: 30 ⏭️

📊 Test Reports by Browser

✅ chromium: View Report • ✅ 458 / ❌ 0 / ⚠️ 2 / ⏭️ 30
✅ chromium-2x: View Report • ✅ 2 / ❌ 0 / ⚠️ 0 / ⏭️ 0
✅ chromium-0.5x: View Report • ✅ 1 / ❌ 0 / ⚠️ 0 / ⏭️ 0
✅ mobile-chrome: View Report • ✅ 6 / ❌ 0 / ⚠️ 0 / ⏭️ 0

🎉 Click on the links above to view detailed test results for each browser configuration.

snomiao · 2025-10-08T17:53:06Z

This might break a lot of other things like branch protection rules

We are lucky! I renamed/moved only Workflow file and its names, and keep all job-names as original so nothing was breaking! You can see "All checks have passed" in this PR.

*branch protection rules matches only job-names

*just rebased

cc @christian-byrne @DrJKL

btw @DrJKL feel free to add commits to this branch for names you want :D

DrJKL

This is looking really nice 😀

DrJKL · 2025-10-08T17:58:37Z

.github/workflows/validate-json.yaml

@@ -1,4 +1,4 @@
-name: Validate JSON


I think @benceruleanlu's idea here was that the root workflow name would 1:1 correspond with the filename, so this would be CI: JSON Validation
(Though I wouldn't mind knowing what JSON was being validated for what reason...)

DrJKL · 2025-10-08T18:01:15Z

.github/workflows/pr-playwright-deploy-forks.yaml

@@ -1,8 +1,10 @@
-name: PR Playwright Deploy (Forks)


I think for the Playwright ones I'd like to keep either Playwright or Browser in the Action name somewhere. Maybe CI: Tests - Browser and CI: Tests - Browser - Forks?
Then it'd align well with CI: Tests - Unit

.github/workflows/README.md

DrJKL · 2025-10-08T18:07:28Z

.github/workflows/README.md

+### Test Workflows (`ci-tests-*`)
+- `ci-tests-e2e.yaml` - End-to-end testing with Playwright
+- `ci-tests-unit.yaml` - Unit and component testing with Vitest
+- `ci-tests-storybook.yaml` - Storybook build and visual regression testing
+- `ci-tests-*-forks.yaml` - Fork-safe deployment workflows (deploy results without exposing secrets)


This kind of documentation can get out of date really quickly.
Can we put comments into the workflows themselves, then have a single e.g. here?

simplified this README.md

and added "description: " fields for each workflow yaml

DrJKL · 2025-10-08T18:07:49Z

.github/workflows/README.md

+- `ci-tests-*-forks.yaml` - Fork-safe deployment workflows (deploy results without exposing secrets)
+
+### PR Label Workflows (`pr-*`)
+These workflows are triggered when specific labels are added to PRs:


This would be a good place to link to GitHub's documentation.

.github/workflows/README.md

Co-authored-by: Alexander Brown <[email protected]>

Add reference to GitHub's official documentation for workflow triggers in the Workflow Triggers section of the workflows README. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>

christian-byrne · 2025-10-10T08:33:09Z

This might break a lot of other things like branch protection rules

We are lucky! I renamed/moved only Workflow file and its names, and keep all job-names as original so nothing was breaking! You can see "All checks have passed" in this PR.

*branch protection rules matches only job-names

That's why you are the GOAT

- Implement systematic naming convention using category prefixes - Group workflows logically: ci-, pr-, release-, types-, i18n- - Rename all 22 workflows for better organization and discoverability - Update workflow cross-references and display names - Add comprehensive README.md with naming guidelines and best practices Key changes: - CI workflows: ci-tests-e2e, ci-tests-unit, ci-tests-storybook, etc. - PR automation: pr-backport, pr-claude-review, pr-playwright-snapshots - Release management: release-version-bump, release-npm-types, etc. - Type generation: types-registry-api, types-manager-api, etc. - Internationalization: i18n-update-core, i18n-update-nodes, etc. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>

Co-authored-by: Alexander Brown <[email protected]>

Add reference to GitHub's official documentation for workflow triggers in the Workflow Triggers section of the workflows README. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>

…ntend into sno-tidy-workflows

- Add descriptive comments to key workflow files explaining purpose and triggers - Simplify workflows README.md to focus on naming convention only - Remove detailed workflow descriptions that can get out of date - Point users to individual workflow files for current documentation Addresses review feedback: documentation can get out of date quickly, put comments into workflows themselves with single example in README. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>

@benceruleanlu

Update all CI workflow names to follow "CI: <Description>" pattern for 1:1 correspondence with filenames as suggested by @benceruleanlu: - ci-json-validation.yaml → "CI: JSON Validation" - ci-lint-format.yaml → "CI: Lint Format" - ci-python-validation.yaml → "CI: Python Validation" - ci-tests-e2e.yaml → "CI: Tests E2E" - ci-tests-unit.yaml → "CI: Tests Unit" - ci-tests-storybook.yaml → "CI: Tests Storybook" - ci-tests-*-forks.yaml → "CI: Tests * Forks" Also added explanation of JSON validation scope (all .json files except tsconfig*.json) to address reviewer question. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>

- Improve table alignment and formatting for category prefixes - Fix missing newline at end of file 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>

…d descriptions across all GitHub Actions workflows to reflect updated conventions. Includes updating the name and description fields across multiple YAML files. No breaking changes.

dosubot bot added the size:L This PR changes 100-499 lines, ignoring generated files. label Oct 2, 2025

snomiao force-pushed the sno-tidy-workflows branch from 7d2dbd4 to b578a42 Compare October 8, 2025 08:26

snomiao assigned DrJKL Oct 8, 2025

snomiao requested review from DrJKL and christian-byrne October 8, 2025 17:54

DrJKL requested changes Oct 8, 2025

View reviewed changes

DrJKL assigned christian-byrne and unassigned DrJKL Oct 8, 2025

DrJKL requested a review from benceruleanlu October 8, 2025 18:12

christian-byrne assigned snomiao Oct 8, 2025

Update .github/workflows/README.md

676792c

Co-authored-by: Alexander Brown <[email protected]>

snomiao mentioned this pull request Oct 8, 2025

CI: Standardize the triggering + Docs Update #5987

Open

snomiao and others added 2 commits October 9, 2025 00:43

rename workflow to 'CI - JSON Validation' to match filename convention

7006800

snomiao and others added 6 commits October 12, 2025 21:29

Update .github/workflows/README.md

f28320f

Co-authored-by: Alexander Brown <[email protected]>

rename workflow to 'CI - JSON Validation' to match filename convention

3803b79

Merge branch 'sno-tidy-workflows' of github.com:Comfy-Org/ComfyUI_fro…

2bdca7c

…ntend into sno-tidy-workflows

snomiao requested review from KarryCharon and Yorha4D as code owners October 13, 2025 23:52

snomiao requested review from a team, Myestery, arjansingh, comfyui-wiki, jtydhr88, ltdrdata, pythongosssss, shinshin86 and viva-jinyi as code owners October 13, 2025 23:52

dosubot bot added size:XL This PR changes 500-999 lines, ignoring generated files. and removed size:L This PR changes 100-499 lines, ignoring generated files. labels Oct 13, 2025

snomiao and others added 4 commits October 13, 2025 23:58

[docs] fix table formatting in workflows README

b864e81

- Improve table alignment and formatting for category prefixes - Fix missing newline at end of file 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>

chore(none): update cicd names\n\nStandardize CI/CD workflow names an…

5a7ec81

…d descriptions across all GitHub Actions workflows to reflect updated conventions. Includes updating the name and description fields across multiple YAML files. No breaking changes.

Merge branch 'main' into sno-tidy-workflows

b719418

dosubot bot added size:M This PR changes 30-99 lines, ignoring generated files. and removed size:XL This PR changes 500-999 lines, ignoring generated files. labels Oct 14, 2025

refactor: reorganize GitHub workflows with consistent naming convention #5891

Are you sure you want to change the base?

refactor: reorganize GitHub workflows with consistent naming convention #5891

Conversation

snomiao commented Oct 2, 2025 • edited by sync-by-unito bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes

Naming Convention

Key Renames

Test Workflow Improvements

Documentation

Benefits

Test Plan

Uh oh!

christian-byrne commented Oct 2, 2025

Uh oh!

DrJKL commented Oct 3, 2025

Uh oh!

christian-byrne commented Oct 3, 2025

Uh oh!

github-actions bot commented Oct 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🎨 Storybook Build Status

🔗 Links

Uh oh!

github-actions bot commented Oct 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🎭 Playwright Test Results

📈 Summary

📊 Test Reports by Browser

Uh oh!

snomiao commented Oct 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

DrJKL left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

christian-byrne commented Oct 10, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

snomiao commented Oct 2, 2025 •

edited by sync-by-unito bot

Loading

github-actions bot commented Oct 8, 2025 •

edited

Loading

github-actions bot commented Oct 8, 2025 •

edited

Loading

snomiao commented Oct 8, 2025 •

edited

Loading